API

Procurement APIs

GET procurement/orders/{purchaseOrderId}

Purchase order details for the provided identifier

HTTP method GET
URI https://api.rambase.net/procurement/orders/{purchaseOrderId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {purchaseOrderId} Purchase order identifier
Integer, minimum 100000
Custom fields Custom fields supported
Successful HTTP status code 200
API resource identifier 290, version 44

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:
1
1

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$showDomainDescriptions Boolean, optional Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false.
$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]
$access_token String, optional After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional Set the database/company for the request
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$useMinimumVersion Integer, optional Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$select String, optional Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information.
$expand String, optional Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information.
$showCustomFields Boolean, optional Set to "true" to include custom fields. Default value is false.

Read more about filters and sorting on how to use filter parameters and named filters.

Read more about filters and sorting on how to use sortable parameters

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<PurchaseOrder>
2
     <PurchaseOrderId
PurchaseOrderId

Purchase order identifier

>{Integer}</PurchaseOrderId>
3
     <Status
Status

Status of the purchase order

Possible domain values can be found here

>{Integer}</Status>
4
     <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
5
     <UpdatedAt
UpdatedAt

Date and time of update

>{Datetime}</UpdatedAt>
6
     <SuppliersReference
SuppliersReference

Suppliers/sellers reference. Typically a person.

>{String}</SuppliersReference>
7
     <SuppliersReferenceNumber
SuppliersReferenceNumber

Suppliers/sellers reference number. Typically to an external system.

>{String}</SuppliersReferenceNumber>
8
     <BuyersReferenceNumber
BuyersReferenceNumber

Buyers reference number

>{String}</BuyersReferenceNumber>
9
     <RegistrationDate
RegistrationDate

Date of registration

>{Date}</RegistrationDate>
10
     <Type
Type

Type of purchase order

Possible domain values can be found here

>{String}</Type>
11
     <SubType
SubType

Subtype of purchase order

Possible domain values can be found here

>{String}</SubType>
12
     <Currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

>{String}</Currency>
13
     <Note
Note

Additional information regarding the object (free text). This note might be visible to customers/suppliers.

>{String}</Note>
14
     <ShipToAttention
ShipToAttention

Attention of the ship to address. When changing ship to address, the ShipToAttention will be overridden by the attention of the new ship to address.

>{String}</ShipToAttention>
15
     <Location>
16
          <LocationId
LocationId

Location identifier

>{Integer}</LocationId>
17
          <Name
Name

Name of location

>{String}</Name>
18
          <ShortName
ShortName

Unique abbreviation/short name of the location

>{String}</ShortName>
19
          <LocationLink
LocationLink

Location reference

>{String}</LocationLink>
20
     </Location>
21
     <Assignee
Assignee

The user who has been assigned to work with this object.

>
22
          <UserId
UserId

User identifier

>{Integer}</UserId>
23
          <Name
Name

Name of the user

>{String}</Name>
24
          <FirstName
FirstName

First name of the user

>{String}</FirstName>
25
          <UserLink
UserLink

User reference

>{String}</UserLink>
26
     </Assignee>
27
     <Supplier>
28
          <SupplierId
SupplierId

RamBase supplier identifier

>{Integer}</SupplierId>
29
          <Name
Name

Name of supplier (name of company or surname/familyname/lastname of a person)

>{String}</Name>
30
          <Phone
Phone

Main phone number of the supplier

This field is greyed out because it is an expandable field. You have to add $expand=Supplier.Phone in your request URI to get this field

>{String}</Phone>
31
          <Email
Email

Main email address to the supplier

This field is greyed out because it is an expandable field. You have to add $expand=Supplier.Email in your request URI to get this field

>{String}</Email>
32
          <Purchase
Purchase

This field is greyed out because it is an expandable field. You have to add $expand=Supplier.Purchase in your request URI to get this field

>
33
               <ConfirmedDeliveryDateBuffer
ConfirmedDeliveryDateBuffer

If the confirmed delivery date is unreliable, you can specify a buffer in days to be added.

This buffer will be used when the requested delivery date for purchase orders is calculated.
This buffer will also be added to the confirmed delivery date when creating purchase order responses.

This field is greyed out because it is an expandable field. You have to add $expand=Supplier.Purchase in your request URI to get this field

>{Integer}</ConfirmedDeliveryDateBuffer>
34
          </Purchase>
35
          <Invoicing
Invoicing

This field is greyed out because it is an expandable field. You have to add $expand=Supplier.Invoicing in your request URI to get this field

>
36
               <DefaultInvoiceAddress
DefaultInvoiceAddress

This field is greyed out because it is an expandable field. You have to add $expand=Supplier.Invoicing in your request URI to get this field

>
37
                    <Attention
Attention

Attention note.

This field is greyed out because it is an expandable field. You have to add $expand=Supplier.Invoicing in your request URI to get this field

>{String}</Attention>
38
                    <AddressLine1
AddressLine1

First address line

This field is greyed out because it is an expandable field. You have to add $expand=Supplier.Invoicing in your request URI to get this field

>{String}</AddressLine1>
39
                    <AddressLine2
AddressLine2

Second address line

This field is greyed out because it is an expandable field. You have to add $expand=Supplier.Invoicing in your request URI to get this field

>{String}</AddressLine2>
40
                    <PostalCode
PostalCode

Postalcode/Postcode/ZIP

This field is greyed out because it is an expandable field. You have to add $expand=Supplier.Invoicing in your request URI to get this field

>{String}</PostalCode>
41
                    <City
City

City/town/village

This field is greyed out because it is an expandable field. You have to add $expand=Supplier.Invoicing in your request URI to get this field

>{String}</City>
42
                    <Region
Region

Region/province/state

This field is greyed out because it is an expandable field. You have to add $expand=Supplier.Invoicing in your request URI to get this field

>{String}</Region>
43
                    <CountryCode
CountryCode

Two-character code (ISO 3166) identifying the country.

This field is greyed out because it is an expandable field. You have to add $expand=Supplier.Invoicing in your request URI to get this field

>{String}</CountryCode>
44
                    <Country
Country

English name of country.

This field is greyed out because it is an expandable field. You have to add $expand=Supplier.Invoicing in your request URI to get this field

>{String}</Country>
45
               </DefaultInvoiceAddress>
46
          </Invoicing>
47
          <SupplierLink
SupplierLink

Supplier reference

>{String}</SupplierLink>
48
     </Supplier>
49
     <Totals>
50
          <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
51
          <TotalAmount
TotalAmount

The total amount in object currency, including VAT

>{Decimal}</TotalAmount>
52
     </Totals>
53
     <TotalsConverted
TotalsConverted

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

>
54
          <Currency
Currency

Currency used in conversion. Default is company accounting currency. Three character code following the ISO 4217 standard.

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

>{String}</Currency>
55
          <ExchangeRate
ExchangeRate

The exchange rate used in convertion

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

>{Decimal}</ExchangeRate>
56
          <TotalAmount
TotalAmount

The total amount in company currency, including VAT.

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

>{Decimal}</TotalAmount>
57
     </TotalsConverted>
58
     <ShipTo>
59
          <Name
Name

Name of receiver (Name of company or last name of a person). Note that default invoice address must have the same name as the customer.

>{String}</Name>
60
          <Firstname
Firstname

Firstname if the receiver is a person. Note that default invoice address must have the same firstname as the customer.

>{String}</Firstname>
61
          <AddressLine1
AddressLine1

First address line

>{String}</AddressLine1>
62
          <AddressLine2
AddressLine2

Second address line

>{String}</AddressLine2>
63
          <PostalCode
PostalCode

Postalcode/Postcode/ZIP

>{String}</PostalCode>
64
          <City
City

City/town/village

>{String}</City>
65
          <Region
Region

Region/province/state

>{String}</Region>
66
          <CountryCode
CountryCode

Two-character code (ISO 3166) identifying the country.

>{String}</CountryCode>
67
          <Country
Country

English name of country.

>{String}</Country>
68
          <Reference>
69
               <Database
Database

Database of the object

>{String}</Database>
70
               <ItemId
ItemId

Item-number of the object

>{Integer}</ItemId>
71
               <ItemType
ItemType

Type of item

>{String}</ItemType>
72
               <ItemLink
ItemLink

API reference to the item

>{String}</ItemLink>
73
               <ObjectId
ObjectId

Identifier of the object

>{Integer}</ObjectId>
74
               <ObjectType
ObjectType

Type of object

>{String}</ObjectType>
75
               <ObjectLink
ObjectLink

API reference to the object

>{String}</ObjectLink>
76
               <RamBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

>{String}</RamBaseKey>
77
          </Reference>
78
     </ShipTo>
79
     <ShipFrom>
80
          <AddressId
AddressId

Address identifier

>{Integer}</AddressId>
81
          <Name
Name

Name of receiver (Name of company or last name of a person). Note that default invoice address must have the same name as the customer.

>{String}</Name>
82
          <AddressLine1
AddressLine1

First address line

>{String}</AddressLine1>
83
          <AddressLine2
AddressLine2

Second address line

>{String}</AddressLine2>
84
          <PostalCode
PostalCode

Postalcode/Postcode/ZIP

>{String}</PostalCode>
85
          <City
City

City/town/village

>{String}</City>
86
          <Region
Region

Region/province/state

>{String}</Region>
87
          <CountryCode
CountryCode

Two-character code (ISO 3166) identifying the country.

>{String}</CountryCode>
88
          <Country
Country

English name of country.

>{String}</Country>
89
          <AddressLink
AddressLink

Supplier address reference

>{String}</AddressLink>
90
     </ShipFrom>
91
     <Shipment>
92
          <DeliveryTerms
DeliveryTerms

Default delivery terms for the supplier. The delivery terms is based on the Incoterms rules from ICC (International Chamber of Commerce).

Possible domain values can be found here

>{String}</DeliveryTerms>
93
          <DeliveryTermPlace
DeliveryTermPlace

A named place, which, together with the content of Delivery terms, determines where and when the costs, responsibility and risk for a shipment are transferred from the seller to the buye

>{String}</DeliveryTermPlace>
94
          <ShippingService>
95
               <ShippingServiceId
ShippingServiceId

Shipping service identifier

>{Integer}</ShippingServiceId>
96
               <Name
Name

Name of shipping service

>{String}</Name>
97
               <Carrier>
98
                    <CarrierId
CarrierId

Carrier identifier

>{Integer}</CarrierId>
99
                    <Name
Name

Name of carrier

This field is greyed out because it is an expandable field. You have to add $expand=Shipment.ShippingService.Carrier.Name in your request URI to get this field

>{String}</Name>
100
                    <CarrierLink
CarrierLink

Carrier reference

>{String}</CarrierLink>
101
               </Carrier>
102
               <ShippingServiceLink
ShippingServiceLink

Shipping service reference

>{String}</ShippingServiceLink>
103
          </ShippingService>
104
     </Shipment>
105
     <Payment>
106
          <PaymentTerms
PaymentTerms

Terms of payment. Defaut value is retrieved from the supplier.

Possible domain values can be found here

>{String}</PaymentTerms>
107
     </Payment>
108
     <HighlightedNotification
HighlightedNotification

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

>
109
          <NotificationId
NotificationId

Notification identifier

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

>{Integer}</NotificationId>
110
          <Status
Status

Status of the notification

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

>{Integer}</Status>
111
          <CreatedAt
CreatedAt

Date and time of creation

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

>{Datetime}</CreatedAt>
112
          <Message
Message

The message from the notification definition, expanded with parameters.

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

>{String}</Message>
113
          <TranslatedMessage
TranslatedMessage

The translated message from the notification definition, expanded with parameters.

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

>{String}</TranslatedMessage>
114
          <NotificationType
NotificationType

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

>
115
               <NotificationTypeId
NotificationTypeId

Notification type identifier

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

>{String}</NotificationTypeId>
116
               <Category
Category

Category of notification type (warning, information etc)

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

>{String}</Category>
117
               <NotificationTypeLink
NotificationTypeLink

Notification type reference

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

>{String}</NotificationTypeLink>
118
          </NotificationType>
119
          <NotificationLink
NotificationLink

Notification reference

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

>{String}</NotificationLink>
120
     </HighlightedNotification>
121
     <ExclusivelyFor
ExclusivelyFor

This field is greyed out because it is an expandable field. You have to add $expand=ExclusivelyFor in your request URI to get this field

>
122
          <ObjectId
ObjectId

Identifier of the object

This field is greyed out because it is an expandable field. You have to add $expand=ExclusivelyFor in your request URI to get this field

>{Integer}</ObjectId>
123
          <ObjectType
ObjectType

Type of object

This field is greyed out because it is an expandable field. You have to add $expand=ExclusivelyFor in your request URI to get this field

>{String}</ObjectType>
124
          <Name
Name

Name of the customer/supplier, or last name if it is a person.

This field is greyed out because it is an expandable field. You have to add $expand=ExclusivelyFor in your request URI to get this field

>{String}</Name>
125
          <FirstName
FirstName

First name of the customer/supplier

This field is greyed out because it is an expandable field. You have to add $expand=ExclusivelyFor in your request URI to get this field

>{String}</FirstName>
126
          <RamBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

This field is greyed out because it is an expandable field. You have to add $expand=ExclusivelyFor in your request URI to get this field

>{String}</RamBaseKey>
127
          <ObjectLink
ObjectLink

API reference to the object

This field is greyed out because it is an expandable field. You have to add $expand=ExclusivelyFor in your request URI to get this field

>{String}</ObjectLink>
128
     </ExclusivelyFor>
129
</PurchaseOrder>
1
{
2
     "purchaseOrder": {
3
          "purchaseOrderId
PurchaseOrderId

Purchase order identifier

": "{Integer}",
4
          "status
Status

Status of the purchase order

Possible domain values can be found here

": "{Integer}",
5
          "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
6
          "updatedAt
UpdatedAt

Date and time of update

": "{Datetime}",
7
          "suppliersReference
SuppliersReference

Suppliers/sellers reference. Typically a person.

": "{String}",
8
          "suppliersReferenceNumber
SuppliersReferenceNumber

Suppliers/sellers reference number. Typically to an external system.

": "{String}",
9
          "buyersReferenceNumber
BuyersReferenceNumber

Buyers reference number

": "{String}",
10
          "registrationDate
RegistrationDate

Date of registration

": "{Date}",
11
          "type
Type

Type of purchase order

Possible domain values can be found here

": "{String}",
12
          "subType
SubType

Subtype of purchase order

Possible domain values can be found here

": "{String}",
13
          "currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

": "{String}",
14
          "note
Note

Additional information regarding the object (free text). This note might be visible to customers/suppliers.

": "{String}",
15
          "shipToAttention
ShipToAttention

Attention of the ship to address. When changing ship to address, the ShipToAttention will be overridden by the attention of the new ship to address.

": "{String}",
16
          "location": {
17
               "locationId
LocationId

Location identifier

": "{Integer}",
18
               "name
Name

Name of location

": "{String}",
19
               "shortName
ShortName

Unique abbreviation/short name of the location

": "{String}",
20
               "locationLink
LocationLink

Location reference

": "{String}"
21
          },
22
          "assignee
Assignee

The user who has been assigned to work with this object.

": {
23
               "userId
UserId

User identifier

": "{Integer}",
24
               "name
Name

Name of the user

": "{String}",
25
               "firstName
FirstName

First name of the user

": "{String}",
26
               "userLink
UserLink

User reference

": "{String}"
27
          },
28
          "supplier": {
29
               "supplierId
SupplierId

RamBase supplier identifier

": "{Integer}",
30
               "name
Name

Name of supplier (name of company or surname/familyname/lastname of a person)

": "{String}",
31
               "phone
Phone

Main phone number of the supplier

This field is greyed out because it is an expandable field. You have to add $expand=Supplier.Phone in your request URI to get this field

": "{String}",
32
               "email
Email

Main email address to the supplier

This field is greyed out because it is an expandable field. You have to add $expand=Supplier.Email in your request URI to get this field

": "{String}",
33
               "purchase
Purchase

This field is greyed out because it is an expandable field. You have to add $expand=Supplier.Purchase in your request URI to get this field

": {
34
                    "confirmedDeliveryDateBuffer
ConfirmedDeliveryDateBuffer

If the confirmed delivery date is unreliable, you can specify a buffer in days to be added.

This buffer will be used when the requested delivery date for purchase orders is calculated.
This buffer will also be added to the confirmed delivery date when creating purchase order responses.

This field is greyed out because it is an expandable field. You have to add $expand=Supplier.Purchase in your request URI to get this field

": "{Integer}"
35
               },
36
               "invoicing
Invoicing

This field is greyed out because it is an expandable field. You have to add $expand=Supplier.Invoicing in your request URI to get this field

": {
37
                    "defaultInvoiceAddress
DefaultInvoiceAddress

This field is greyed out because it is an expandable field. You have to add $expand=Supplier.Invoicing in your request URI to get this field

": {
38
                         "attention
Attention

Attention note.

This field is greyed out because it is an expandable field. You have to add $expand=Supplier.Invoicing in your request URI to get this field

": "{String}",
39
                         "addressLine1
AddressLine1

First address line

This field is greyed out because it is an expandable field. You have to add $expand=Supplier.Invoicing in your request URI to get this field

": "{String}",
40
                         "addressLine2
AddressLine2

Second address line

This field is greyed out because it is an expandable field. You have to add $expand=Supplier.Invoicing in your request URI to get this field

": "{String}",
41
                         "postalCode
PostalCode

Postalcode/Postcode/ZIP

This field is greyed out because it is an expandable field. You have to add $expand=Supplier.Invoicing in your request URI to get this field

": "{String}",
42
                         "city
City

City/town/village

This field is greyed out because it is an expandable field. You have to add $expand=Supplier.Invoicing in your request URI to get this field

": "{String}",
43
                         "region
Region

Region/province/state

This field is greyed out because it is an expandable field. You have to add $expand=Supplier.Invoicing in your request URI to get this field

": "{String}",
44
                         "countryCode
CountryCode

Two-character code (ISO 3166) identifying the country.

This field is greyed out because it is an expandable field. You have to add $expand=Supplier.Invoicing in your request URI to get this field

": "{String}",
45
                         "country
Country

English name of country.

This field is greyed out because it is an expandable field. You have to add $expand=Supplier.Invoicing in your request URI to get this field

": "{String}"
46
                    }
47
               },
48
               "supplierLink
SupplierLink

Supplier reference

": "{String}"
49
          },
50
          "totals": {
51
               "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
52
               "totalAmount
TotalAmount

The total amount in object currency, including VAT

": "{Decimal}"
53
          },
54
          "totalsConverted
TotalsConverted

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

": {
55
               "currency
Currency

Currency used in conversion. Default is company accounting currency. Three character code following the ISO 4217 standard.

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

": "{String}",
56
               "exchangeRate
ExchangeRate

The exchange rate used in convertion

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

": "{Decimal}",
57
               "totalAmount
TotalAmount

The total amount in company currency, including VAT.

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

": "{Decimal}"
58
          },
59
          "shipTo": {
60
               "name
Name

Name of receiver (Name of company or last name of a person). Note that default invoice address must have the same name as the customer.

": "{String}",
61
               "firstname
Firstname

Firstname if the receiver is a person. Note that default invoice address must have the same firstname as the customer.

": "{String}",
62
               "addressLine1
AddressLine1

First address line

": "{String}",
63
               "addressLine2
AddressLine2

Second address line

": "{String}",
64
               "postalCode
PostalCode

Postalcode/Postcode/ZIP

": "{String}",
65
               "city
City

City/town/village

": "{String}",
66
               "region
Region

Region/province/state

": "{String}",
67
               "countryCode
CountryCode

Two-character code (ISO 3166) identifying the country.

": "{String}",
68
               "country
Country

English name of country.

": "{String}",
69
               "reference": {
70
                    "database
Database

Database of the object

": "{String}",
71
                    "itemId
ItemId

Item-number of the object

": "{Integer}",
72
                    "itemType
ItemType

Type of item

": "{String}",
73
                    "itemLink
ItemLink

API reference to the item

": "{String}",
74
                    "objectId
ObjectId

Identifier of the object

": "{Integer}",
75
                    "objectType
ObjectType

Type of object

": "{String}",
76
                    "objectLink
ObjectLink

API reference to the object

": "{String}",
77
                    "ramBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

": "{String}"
78
               }
79
          },
80
          "shipFrom": {
81
               "addressId
AddressId

Address identifier

": "{Integer}",
82
               "name
Name

Name of receiver (Name of company or last name of a person). Note that default invoice address must have the same name as the customer.

": "{String}",
83
               "addressLine1
AddressLine1

First address line

": "{String}",
84
               "addressLine2
AddressLine2

Second address line

": "{String}",
85
               "postalCode
PostalCode

Postalcode/Postcode/ZIP

": "{String}",
86
               "city
City

City/town/village

": "{String}",
87
               "region
Region

Region/province/state

": "{String}",
88
               "countryCode
CountryCode

Two-character code (ISO 3166) identifying the country.

": "{String}",
89
               "country
Country

English name of country.

": "{String}",
90
               "addressLink
AddressLink

Supplier address reference

": "{String}"
91
          },
92
          "shipment": {
93
               "deliveryTerms
DeliveryTerms

Default delivery terms for the supplier. The delivery terms is based on the Incoterms rules from ICC (International Chamber of Commerce).

Possible domain values can be found here

": "{String}",
94
               "deliveryTermPlace
DeliveryTermPlace

A named place, which, together with the content of Delivery terms, determines where and when the costs, responsibility and risk for a shipment are transferred from the seller to the buye

": "{String}",
95
               "shippingService": {
96
                    "shippingServiceId
ShippingServiceId

Shipping service identifier

": "{Integer}",
97
                    "name
Name

Name of shipping service

": "{String}",
98
                    "carrier": {
99
                         "carrierId
CarrierId

Carrier identifier

": "{Integer}",
100
                         "name
Name

Name of carrier

This field is greyed out because it is an expandable field. You have to add $expand=Shipment.ShippingService.Carrier.Name in your request URI to get this field

": "{String}",
101
                         "carrierLink
CarrierLink

Carrier reference

": "{String}"
102
                    },
103
                    "shippingServiceLink
ShippingServiceLink

Shipping service reference

": "{String}"
104
               }
105
          },
106
          "payment": {
107
               "paymentTerms
PaymentTerms

Terms of payment. Defaut value is retrieved from the supplier.

Possible domain values can be found here

": "{String}"
108
          },
109
          "highlightedNotification
HighlightedNotification

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

": {
110
               "notificationId
NotificationId

Notification identifier

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

": "{Integer}",
111
               "status
Status

Status of the notification

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

": "{Integer}",
112
               "createdAt
CreatedAt

Date and time of creation

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

": "{Datetime}",
113
               "message
Message

The message from the notification definition, expanded with parameters.

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

": "{String}",
114
               "translatedMessage
TranslatedMessage

The translated message from the notification definition, expanded with parameters.

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

": "{String}",
115
               "notificationType
NotificationType

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

": {
116
                    "notificationTypeId
NotificationTypeId

Notification type identifier

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

": "{String}",
117
                    "category
Category

Category of notification type (warning, information etc)

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

": "{String}",
118
                    "notificationTypeLink
NotificationTypeLink

Notification type reference

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

": "{String}"
119
               },
120
               "notificationLink
NotificationLink

Notification reference

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

": "{String}"
121
          },
122
          "exclusivelyFor
ExclusivelyFor

This field is greyed out because it is an expandable field. You have to add $expand=ExclusivelyFor in your request URI to get this field

": {
123
               "objectId
ObjectId

Identifier of the object

This field is greyed out because it is an expandable field. You have to add $expand=ExclusivelyFor in your request URI to get this field

": "{Integer}",
124
               "objectType
ObjectType

Type of object

This field is greyed out because it is an expandable field. You have to add $expand=ExclusivelyFor in your request URI to get this field

": "{String}",
125
               "name
Name

Name of the customer/supplier, or last name if it is a person.

This field is greyed out because it is an expandable field. You have to add $expand=ExclusivelyFor in your request URI to get this field

": "{String}",
126
               "firstName
FirstName

First name of the customer/supplier

This field is greyed out because it is an expandable field. You have to add $expand=ExclusivelyFor in your request URI to get this field

": "{String}",
127
               "ramBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

This field is greyed out because it is an expandable field. You have to add $expand=ExclusivelyFor in your request URI to get this field

": "{String}",
128
               "objectLink
ObjectLink

API reference to the object

This field is greyed out because it is an expandable field. You have to add $expand=ExclusivelyFor in your request URI to get this field

": "{String}"
129
          }
130
     }
131
}

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

POST
Forward all purchase order items to a new purchase order response
Forwards all purchase order items to an existing purchase order response
AOP/100454
POST
Forward all purchase order items to an existing purchase order response
Forwards all purchase order items to an existing purchase order response
AOP/100455
POST
Delete all items for purchase order
Deletes all items existing on a purchase order
AOP/100456
POST
Update requested delivery date for purchase order on multiple items
Update requested delivery date for selected items on a purchase order
AOP/100460
POST
Update requested delivery date on all items
Updates requested delivery date on all items of a purchase order
AOP/100461
POST
Register purchase order
Registers a purchase order
AOP/100463
POST
Lock all assignments for purchase order
Locks all assignments for a purchase order
AOP/100467
POST
Forward all purchase order items to a new goods reception
Forwrads all purchase order items to a new goods reception
AOP/100471
POST
Forward multiple purchase order items to a new purchase order response
Forwards multiple purchase order items to a new purchase order response
AOP/100477
POST
Copy suppliers reference number to all items
AOP/100480
POST
Forward all purchase orders to existing goods reception
Forwrads all SSA items to an existing goods reception
AOP/100481
POST
Forward multiple purchase order items to an existing purchase order response
Forwards multiple purchase order items to an existing purchase order response
AOP/100488
POST
Delete multiple items for a purchase order
Deletes multiple items for a purchase order
AOP/100489
POST
Unlock all assignment for purchase order
Unlocks all assignments for purchase order
AOP/100493
POST
Copy purchase order to a new purchase order
Copies purchase order to a new purchase order
AOP/100507
POST
Merge multiple items into one item
Merges multiple items into one item
AOP/100512
POST
Assign available quantity to un-assigned sales orders and production orders
Assigns available quantity to un-assigned sales orders and production orders
AOP/100514
POST
Forward all purchase order items to a new supplier invoice
Forwards all purchase order items to a new supplier invoice
AOP/100527
POST
Forward all purchase order items to an existing supplier invoice
Forwards all purchase order items to an existing supplier invoice
AOP/100531
POST
Product received for all items on a purchase order
Sets alle purchase order items in status 3, that carries a product that is not using assignments, to status 4. This is to indicate that the product or service is received/executed.
AOP/100533
POST
Create change requests for all items on purchase order
Create change requests for all items on purchase order
AOP/100538
POST
Forward multiple purchase order items to a new goods reception
AOP/100723
POST
Forward multiple purchase order items to existing goods reception
AOP/100726
POST
Product received for multiple items on a purchase order
Sets selected purchase order items in status 3, that carries a product that is not using assignments, to status 4. This is to indicate that the product or service is received/executed.
AOP/100732
POST
Set purchase order as inbound rental
Mark purchase order as inbound rental order and reassign all assignments to pending and recalculate st:1
AOP/100975
POST
Change ship-to address on purchase order
Sets the ship-to address to selected supplier's or use address from warehouse location. When address from location is selected, both SupplierId and AddressId are empty.
AOP/101060
POST
Cancel purchase order
Cancel all items in purchase order
AOP/101337
POST
Cancel multiple purchase order items
AOP/101344
POST
Set as owned by customer
This operation will set the purchase order as owned by customer, so that when it arrives stock it will belong to this customer.
AOP/101441
POST
Change owner (customer)
This operation changes the owner (the customer that will own the goods when it arrives at warehouse).
AOP/101442

Possible error codes the response might return:

Error 100047 HTTP 404 Supplier not found
Error 100104 HTTP 404 Address not found
Error 100001 HTTP 404 Address not found